home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / sbin / aspell-autobuildhash < prev    next >
Encoding:
Text File  |  2009-05-15  |  9.0 KB  |  295 lines
  1. #!/usr/bin/perl -w
  2. #
  3. #  script for aspell hash autorebuild in Debian systems
  4. #
  5. # Copyright 2004-2009 Agustin Martin Domingo <agmartin@debian.org>
  6. #
  7. #
  8. # This program is free software; you can redistribute it and/or modify
  9. # it under the terms of the GNU General Public License as published by
  10. # the Free Software Foundation; either version 2 of the License, or
  11. # (at your option) any later version.
  12. #
  13. # This program is distributed in the hope that it will be useful,
  14. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16. # GNU General Public License for more details.
  17. #
  18. # You should have received a copy of the GNU General Public License
  19. # along with this program; if not, write to the Free Software
  20. # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21. #
  22.  
  23. sub usage {
  24.     print STDERR "\nUsage:\taspell-autobuildhash [--debug] [--force]\n"
  25.     . "\n"
  26.     . "Options:\n"
  27.     . "\t--debug         Show debugging infor about aspell-autobuildhash\n"
  28.     . "\t                internal work. Will also enable aspell affix validation.\n"
  29.     . "\t--force         Do the job regardless of versions comparisons.\n";
  30. }
  31.  
  32. sub debugprint {
  33.     print STDERR "@_\n" if $debug;
  34. }
  35.  
  36. sub mymessage{
  37.     my $message  = join(" ",@_);
  38.     my $question = "dictionaries-common/ispell-autobuildhash-message";
  39.     my $hashfile = '';
  40.  
  41.     if ( $lang ) {
  42.     $hashfile = "$lang";
  43.     } else {
  44.     $hashfile = "dictionaries-common";
  45.     }
  46.  
  47.     subst($question,"xxpell","aspell");
  48.     subst($question,"XXpell","Aspell");
  49.     subst($question,"hashfile",$hashfile);
  50.     subst($question,"errormsg",$message);
  51.     fset ($question,"seen","false");
  52.     title("dictionaries-common: Running aspell-autobuildhash");
  53.     input("critical",$question);
  54.     go ();
  55. }
  56.  
  57. sub myerror {
  58.     mymessage @_;
  59.     exit 1;
  60. }
  61.  
  62. # ---------------------------------------------------------------------
  63. #      Handle autorebuilding
  64. # ---------------------------------------------------------------------
  65.  
  66. sub autorebuild {
  67.     my $lang      = shift ||                              # The dictionary name
  68.     myerror "No argument passed to function autorebuild";
  69.     my $data      = "/usr/lib/aspell";                    # The data/lib dir
  70.     my $langsfile = "/usr/share/aspell/$lang.contents";   # The subdicts file
  71.     my $options   = " --per-conf=/dev/null ";             # Make sure no personal conf is used at all
  72.     my @sublangs  = ();
  73.  
  74.     $options     .= " --dont-validate-affixes " unless $debug;
  75.  
  76.     myerror "aspell data dir $data does not exist" unless ( -d $data );
  77.  
  78.     if ( -e $langsfile ){
  79.     open (LANGSFILE, "< $langsfile") || die "Could not open $langsfile for reading";
  80.     @sublangs = <LANGSFILE>;
  81.     close LANGSFILE;
  82.     } else {
  83.     push @sublangs, $lang;
  84.     }
  85.  
  86.     foreach ( @sublangs ){
  87.  
  88.     next if m/^[\t\s]*$/;
  89.     chomp;
  90.     s/^[\s\t]*//;
  91.     s/[\s\t]*$//;
  92.     next if m/^\#/;
  93.  
  94.     my $sublang = $_;
  95.     my $base    = "/usr/share/aspell/$sublang";     # the wordlist basename
  96.     my $hash    = "/var/lib/aspell/$sublang.rws";   # the hash file
  97.     my $msg     = '';
  98.     my $unpack  = '';
  99.  
  100.     print STDERR "aspell-autobuildhash: processing: $lang [$sublang]\n";
  101.  
  102.  
  103.     if ( -e "$base.mwl.gz" ){
  104.         $unpack = "zcat $base.mwl.gz";
  105.     } elsif ( -e "$base.wl.gz") {
  106.         $unpack = "zcat $base.wl.gz";
  107.     } elsif ( -e "$base.cwl.gz") {
  108.         $unpack = "zcat $base.cwl.gz | precat";
  109.     } else {
  110.         mymessage "Could not find any of $base.{mwl,wl,cwl}.gz";
  111.         return 0;
  112.     }
  113.  
  114.     #$unpack = "$unpack | aspell clean strict";
  115.     system ("$unpack | aspell $options --local-data-dir=$data --lang=$lang create master $hash") == 0
  116.         or $msg = "Could not build the hash file for $sublang" ;
  117.  
  118.     if ( $msg ){             # Do not break postinst if hash cannot be built
  119.         mymessage ($msg);    # Just inform about that
  120.         return 0;
  121.     }
  122.     }
  123.     return 1;
  124. }
  125.  
  126. # ---------------------------------------------------------------------
  127. #                   Get aspell compat version
  128. # ---------------------------------------------------------------------
  129.  
  130. sub get_aspell_compat {
  131.  
  132.     my $aspell_compat = '';
  133.  
  134.     if ( -e $aspellcompatfile ){
  135.     open (COMPAT,"$aspellcompatfile");
  136.     chomp ( $aspell_compat = <COMPAT> );
  137.     close COMPAT;
  138.     } else {
  139.     $force = "yes";
  140.     }
  141.     return $aspell_compat;
  142. }
  143.  
  144. # ---------------------------------------------------------------------
  145. #                        The main program
  146. # ---------------------------------------------------------------------
  147.  
  148. use Debian::DictionariesCommon q(dico_checkroot);
  149. use Debconf::Client::ConfModule q(:all);
  150. use Getopt::Long;
  151.  
  152. dico_checkroot();
  153.  
  154. $compatdir        = "/var/lib/aspell";
  155. $aspellcompatfile = "/usr/share/aspell/aspell.compat";
  156.  
  157. $force        = '';
  158. $debug        = '';
  159.  
  160. GetOptions ('debug' => \$debug,
  161.         'force' => \$force) or usage();
  162.  
  163. if ( -x "/usr/bin/aspell" ){
  164.  
  165.     $aspell_compat = get_aspell_compat();
  166.  
  167.     foreach $compat ( <$compatdir/*.compat> ){
  168.     my $build_hash  = '';
  169.     my $lang_compat = '';
  170.  
  171.     $lang = $compat;
  172.     $lang =~ s/\.compat$//;
  173.     $lang =~ s/.*\///;
  174.  
  175.     open (COMPAT,"$compat");
  176.     $lang_compat = <COMPAT>;
  177.     close COMPAT;
  178.     $lang_compat = 0     if not $lang_compat;
  179.     chomp $lang_compat;
  180.  
  181.     $build_hash  = "yes" if ( $aspell_compat ne $lang_compat );
  182.     $build_hash  = "yes" if $force;
  183.  
  184.     if ( $build_hash ){
  185.         debugprint "$lang => aspell_compat: [$aspell_compat]; lang_compat: [$lang_compat]";
  186.         if ( autorebuild($lang) ){
  187.         debugprint " +++ Updating $compat";
  188.         open (COMPAT,">","$compat");
  189.         if ( $aspell_compat ){
  190.             print COMPAT "$aspell_compat\n";
  191.         } else {
  192.             print COMPAT "0\n";
  193.         }
  194.         close COMPAT;
  195.         } else {
  196.         debugprint " --- $compat not updated because of an error";
  197.         }
  198.     }
  199.     }
  200. } else {
  201.     debugprint " aspell is not installed. Doing nothing";
  202. }
  203.  
  204. __END__
  205.  
  206. =head1 NAME
  207.  
  208. B<aspell-autobuildhash> - Autobuilding aspell hash files for some dicts
  209.  
  210. =head1 SYNOPSIS
  211.  
  212.  aspell-autobuildhash [--force]
  213.  
  214.    Options:
  215.     --debug      Show extra info about aspell-autobuildhash internal
  216.                  work. Will also enable aspell affix validation.
  217.     --force      Rebuild the hash file for all dicts providing a
  218.                  compat file skipping the test.
  219.  
  220. =head1 DESCRIPTION
  221.  
  222. B<aspell-autobuildhash> is a script that will manage aspell hash files
  223. autobuild, intended to be called from the dictionaries-common tools.
  224. Depending on the aspell
  225. compatibility level and on the compatibility level used for the hash file
  226. if present, will decide whether it must be rebuilt or not. This script will
  227. only work on aspell packages prepared to use it, it will do nothing for other
  228. aspell dict packages.
  229.  
  230. =head1 OPTIONS
  231.  
  232.  --debug      Show some extra information about aspell-autobuildhash
  233.               internal work. Will also enable aspell affix validation.
  234.  --force      Rebuild the hash file for all dicts providing a compat
  235.               file regardless of the compatibility levels found.
  236.  
  237. =head1 PACKAGE MAINTAINERS
  238.  
  239. To use this system, just provide a F<$lang.compat> file in F</var/lib/aspell>
  240. (I<$lang> stands for the lang basename with variant if any, e.g. I<gl-minimos>
  241. or I<en>). Put a "0" in it or just create an empty one with touch.
  242.  
  243. Wordlists should previously be compressed either with gzip
  244. (and their extensions set as F<.mwl.gz> or F<.wl.gz>) or preferably
  245. first with aspell prezip and then gzipped (with F<.cwl.gz> extension).
  246. This applies both for plain wordlists and munched wordlists
  247. (in the ispell way) if you use affix compression.
  248.  
  249. If your package will provide a single hash, install prezipped+gzipped
  250. wordlist as F</usr/share/aspell/$lang.cwl.gz> or, if prezip is not used,
  251. as F</usr/share/aspell/$lang.mwl.gz>.
  252.  
  253. If your package will provide more than one aspell hash for the same $lang,
  254. you will need to place each compressed wordlist as e.g.
  255. F</usr/share/aspell/$subdict.cwl.gz>, and the common F<$lang.compat> as
  256. above. Then create a F</usr/share/aspell/$lang.contents> file with the
  257. base names of the subdicts, one in a line. For English that will contain,
  258. amongst other possible lines
  259.  
  260.  en-common
  261.  en-variant_0
  262.  en-variant_1
  263.  en-variant_2
  264.  en_CA-w_accents-only
  265.  
  266. No need to use this file if a single hash is being created.
  267.  
  268. Dictionaries-common scripts will call internally this script and create a
  269. single hash file at F</var/lib/ispell/$lang.rws>, or hash files at
  270. F</var/lib/ispell/$subdict.rws>. You must set a symlink to that
  271. files from F</usr/lib/aspell/$lang.rws> or
  272. F</usr/lib/aspell/$subdict.rws> as appropriate.
  273. You are also suggested to create empty files at
  274. F</var/lib/aspell/$lang.rws> or for all of the
  275. F</var/lib/aspell/$subdict.rws> in the install target of
  276. your package build process. This empty file will be overwritten when the
  277. real hash is created, but will make the hash be removed at package
  278. removal without any magic being done in the postrm and will also help to
  279. keep track about which package owns that file.
  280.  
  281. If you use B<debhelper> you may want to pass B<-Xvar/lib/aspell> option
  282. to B<dh_md5sums> call in your F<debian/rules> file, to avoid B<debsums>
  283. complaining about those hash and compat files.
  284.  
  285. B<aspell> maintainer should also call this script from package postinst.
  286. When comparing versions it will get the aspell version from file
  287. F</usr/share/aspell/aspell.compat>.
  288.  
  289. =head1 AUTHORS
  290.  
  291. Agustin Martin <agmartin@debian.org>
  292.  
  293. =cut
  294.  
  295.